﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed

#pragma once

#include "ICurve.h"

namespace gcmp
{
    /// \brief 三维曲线
    ///
    class ICurve3d : public ICurve
    {
        DEFINE_CAST_DERIVED(gcmp::ICurve3d, gcmp::ICurve);
    public:
        /// \brief  获取三维曲线的起点
        /// \return 起点
        virtual Vector3d GetStartPoint() const = 0;

        /// \brief  获取三维曲线的终点
        /// \return 终点
        virtual Vector3d GetEndPoint() const = 0;

        /// \brief  根据参数求三维曲线上的点
        /// \param parameter      参数
        /// \return 参数对应的点
        virtual Vector3d GetPoint(double parameter)const = 0;

        /// \brief  根据参数求三维曲线上的对应位置的切向
        /// \param parameter      参数
        /// \return 切向
        virtual Vector3d GetTangent(double parameter)const = 0;

        /// \brief  获取三维曲线的中点
        /// \return 中点
        virtual Vector3d GetMiddlePoint() const = 0;

        /// \brief  计算三维曲线起点的切向
        /// \return 起点的切向
        virtual Vector3d GetStartTangent() const = 0;

        /// \brief  计算三维曲线终点的切向
        /// \return 终点的切向
        virtual Vector3d GetEndTangent() const = 0;

        /// \brief 根据坐标点计算对应三维曲线上的参数值
        /// \param pointOnCurve            查询点
        /// \param distEpsilon             距离容差(参考值0.0001)
        /// \param pointParameter          点在曲线上的参数
        /// \param isParameterInRange      求得的参数是否在曲线的参数区间内（true表示在，false表示不在）
        /// \return 点在二维曲线上（求得的参数对应的点和已知点得距离小于距离容差）返回True，否则返回false
        virtual bool GetParameter(const Vector3d &pointOnCurve, double &pointParameter, bool &isParameterInRange, double distEpsilon) const = 0;
        

    public:
        virtual ~ICurve3d() {}
    };
}